Safe Haskell	Safe-Inferred
Language	Haskell2010

Distribution.Types.BuildInfo

Synopsis

data BuildInfo = BuildInfo {
- buildable :: Bool
- buildTools :: [LegacyExeDependency]
- buildToolDepends :: [ExeDependency]
- cppOptions :: [String]
- asmOptions :: [String]
- cmmOptions :: [String]
- ccOptions :: [String]
- cxxOptions :: [String]
- ldOptions :: [String]
- hsc2hsOptions :: [String]
- pkgconfigDepends :: [PkgconfigDependency]
- frameworks :: [RelativePath Framework File]
- extraFrameworkDirs :: [SymbolicPath Pkg (Dir Framework)]
- asmSources :: [SymbolicPath Pkg File]
- cmmSources :: [SymbolicPath Pkg File]
- cSources :: [SymbolicPath Pkg File]
- cxxSources :: [SymbolicPath Pkg File]
- jsSources :: [SymbolicPath Pkg File]
- hsSourceDirs :: [SymbolicPath Pkg (Dir Source)]
- otherModules :: [ModuleName]
- virtualModules :: [ModuleName]
- autogenModules :: [ModuleName]
- defaultLanguage :: Maybe Language
- otherLanguages :: [Language]
- defaultExtensions :: [Extension]
- otherExtensions :: [Extension]
- oldExtensions :: [Extension]
- extraLibs :: [String]
- extraLibsStatic :: [String]
- extraGHCiLibs :: [String]
- extraBundledLibs :: [String]
- extraLibFlavours :: [String]
- extraDynLibFlavours :: [String]
- extraLibDirs :: [SymbolicPath Pkg (Dir Lib)]
- extraLibDirsStatic :: [SymbolicPath Pkg (Dir Lib)]
- includeDirs :: [SymbolicPath Pkg (Dir Include)]
- includes :: [SymbolicPath Include File]
- autogenIncludes :: [RelativePath Include File]
- installIncludes :: [RelativePath Include File]
- options :: PerCompilerFlavor [String]
- profOptions :: PerCompilerFlavor [String]
- sharedOptions :: PerCompilerFlavor [String]
- staticOptions :: PerCompilerFlavor [String]
- customFieldsBI :: [(String, String)]
- targetBuildDepends :: [Dependency]
- mixins :: [Mixin]
}
emptyBuildInfo :: BuildInfo
allLanguages :: BuildInfo -> [Language]
allExtensions :: BuildInfo -> [Extension]
usedExtensions :: BuildInfo -> [Extension]
usesTemplateHaskellOrQQ :: BuildInfo -> Bool
hcOptions :: CompilerFlavor -> BuildInfo -> [String]
hcProfOptions :: CompilerFlavor -> BuildInfo -> [String]
hcSharedOptions :: CompilerFlavor -> BuildInfo -> [String]
hcStaticOptions :: CompilerFlavor -> BuildInfo -> [String]

Documentation

data BuildInfo Source #

Constructors

BuildInfo

Fields

buildable :: Bool
component is buildable here
buildTools :: [LegacyExeDependency]
Tools needed to build this bit.
This is a legacy field that buildToolDepends largely supersedes.
Unless use are very sure what you are doing, use the functions in Distribution.Simple.BuildToolDepends rather than accessing this field directly.
buildToolDepends :: [ExeDependency]
Haskell tools needed to build this bit
This field is better than buildTools because it allows one to precisely specify an executable in a package.
Unless use are very sure what you are doing, use the functions in Distribution.Simple.BuildToolDepends rather than accessing this field directly.
cppOptions :: [String]
options for pre-processing Haskell code
asmOptions :: [String]
options for assembler
cmmOptions :: [String]
options for C-- compiler
ccOptions :: [String]
options for C compiler
cxxOptions :: [String]
options for C++ compiler
ldOptions :: [String]
options for linker
hsc2hsOptions :: [String]
options for hsc2hs
pkgconfigDepends :: [PkgconfigDependency]
pkg-config packages that are used
frameworks :: [RelativePath Framework File]
support frameworks for Mac OS X
extraFrameworkDirs :: [SymbolicPath Pkg (Dir Framework)]
extra locations to find frameworks.
asmSources :: [SymbolicPath Pkg File]
Assembly files.
cmmSources :: [SymbolicPath Pkg File]
C-- files.
cSources :: [SymbolicPath Pkg File]
cxxSources :: [SymbolicPath Pkg File]
jsSources :: [SymbolicPath Pkg File]
hsSourceDirs :: [SymbolicPath Pkg (Dir Source)]
where to look for the Haskell module hierarchy
otherModules :: [ModuleName]
non-exposed or non-main modules
virtualModules :: [ModuleName]
exposed modules that do not have a source file (e.g. GHC.Prim from ghc-prim package)
autogenModules :: [ModuleName]
not present on sdist, Paths_* or user-generated with a custom Setup.hs
defaultLanguage :: Maybe Language
language used when not explicitly specified
otherLanguages :: [Language]
other languages used within the package
defaultExtensions :: [Extension]
language extensions used by all modules
otherExtensions :: [Extension]
other language extensions used within the package
oldExtensions :: [Extension]
the old extensions field, treated same as defaultExtensions
extraLibs :: [String]
what libraries to link with when compiling a program that uses your package
extraLibsStatic :: [String]
what libraries to link with when compiling a program fully statically that uses your package
extraGHCiLibs :: [String]
if present, overrides extraLibs when package is loaded with GHCi.
extraBundledLibs :: [String]
if present, adds libs to hs-libraries, which become part of the package. Example 1: the Cffi library shipping with the rts, alongside the HSrts-1.0.a,.o,... Example 2: a library that is being built by a foreign tool (e.g. rust) and copied and registered together with this library. The logic on how this library is built will have to be encoded in a custom Setup for now. Otherwise cabal would need to learn how to call arbitrary library builders.
extraLibFlavours :: [String]
Hidden Flag. This set of strings, will be appended to all libraries when copying. E.g. [libHSname_flavour | flavour <- extraLibFlavours]. This should only be needed in very specific cases, e.g. the rts package, where there are multiple copies of slightly differently built libs.
extraDynLibFlavours :: [String]
Hidden Flag. This set of strings will be appended to all dynamic libraries when copying. This is particularly useful with the rts package, where we want different dynamic flavours of the RTS library to be installed.
extraLibDirs :: [SymbolicPath Pkg (Dir Lib)]
extraLibDirsStatic :: [SymbolicPath Pkg (Dir Lib)]
includeDirs :: [SymbolicPath Pkg (Dir Include)]
directories to find .h files
includes :: [SymbolicPath Include File]
The .h files to be found in includeDirs
autogenIncludes :: [RelativePath Include File]
The .h files to be generated (e.g. by autoconf)
installIncludes :: [RelativePath Include File]
.h files to install with the package
options :: PerCompilerFlavor [String]
profOptions :: PerCompilerFlavor [String]
sharedOptions :: PerCompilerFlavor [String]
staticOptions :: PerCompilerFlavor [String]
customFieldsBI :: [(String, String)]
Custom fields starting with x-, stored in a simple assoc-list.
targetBuildDepends :: [Dependency]
Dependencies specific to a library or executable target
mixins :: [Mixin]

Instances

Instances details

HasBuildInfo BuildInfo Source #
Instance details Defined in Distribution.Types.BuildInfo.Lens Methods buildInfo :: Lens' BuildInfo BuildInfo Source # buildable :: Lens' BuildInfo Bool Source # buildTools :: Lens' BuildInfo [LegacyExeDependency] Source # buildToolDepends :: Lens' BuildInfo [ExeDependency] Source # cppOptions :: Lens' BuildInfo [String] Source # asmOptions :: Lens' BuildInfo [String] Source # cmmOptions :: Lens' BuildInfo [String] Source # ccOptions :: Lens' BuildInfo [String] Source # cxxOptions :: Lens' BuildInfo [String] Source # ldOptions :: Lens' BuildInfo [String] Source # hsc2hsOptions :: Lens' BuildInfo [String] Source # pkgconfigDepends :: Lens' BuildInfo [PkgconfigDependency] Source # frameworks :: Lens' BuildInfo [RelativePath Framework 'File] Source # extraFrameworkDirs :: Lens' BuildInfo [SymbolicPath Pkg ('Dir Framework)] Source # asmSources :: Lens' BuildInfo [SymbolicPath Pkg 'File] Source # cmmSources :: Lens' BuildInfo [SymbolicPath Pkg 'File] Source # cSources :: Lens' BuildInfo [SymbolicPath Pkg 'File] Source # cxxSources :: Lens' BuildInfo [SymbolicPath Pkg 'File] Source # jsSources :: Lens' BuildInfo [SymbolicPath Pkg 'File] Source # hsSourceDirs :: Lens' BuildInfo [SymbolicPath Pkg ('Dir Source)] Source # otherModules :: Lens' BuildInfo [ModuleName] Source # virtualModules :: Lens' BuildInfo [ModuleName] Source # autogenModules :: Lens' BuildInfo [ModuleName] Source # defaultLanguage :: Lens' BuildInfo (Maybe Language) Source # otherLanguages :: Lens' BuildInfo [Language] Source # defaultExtensions :: Lens' BuildInfo [Extension] Source # otherExtensions :: Lens' BuildInfo [Extension] Source # oldExtensions :: Lens' BuildInfo [Extension] Source # extraLibs :: Lens' BuildInfo [String] Source # extraLibsStatic :: Lens' BuildInfo [String] Source # extraGHCiLibs :: Lens' BuildInfo [String] Source # extraBundledLibs :: Lens' BuildInfo [String] Source # extraLibFlavours :: Lens' BuildInfo [String] Source # extraDynLibFlavours :: Lens' BuildInfo [String] Source # extraLibDirs :: Lens' BuildInfo [SymbolicPath Pkg ('Dir Lib)] Source # extraLibDirsStatic :: Lens' BuildInfo [SymbolicPath Pkg ('Dir Lib)] Source # includeDirs :: Lens' BuildInfo [SymbolicPath Pkg ('Dir Include)] Source # includes :: Lens' BuildInfo [SymbolicPath Include 'File] Source # autogenIncludes :: Lens' BuildInfo [RelativePath Include 'File] Source # installIncludes :: Lens' BuildInfo [RelativePath Include 'File] Source # options :: Lens' BuildInfo (PerCompilerFlavor [String]) Source # profOptions :: Lens' BuildInfo (PerCompilerFlavor [String]) Source # sharedOptions :: Lens' BuildInfo (PerCompilerFlavor [String]) Source # staticOptions :: Lens' BuildInfo (PerCompilerFlavor [String]) Source # customFieldsBI :: Lens' BuildInfo [(String, String)] Source # targetBuildDepends :: Lens' BuildInfo [Dependency] Source # mixins :: Lens' BuildInfo [Mixin] Source #
Structured BuildInfo Source #
Instance details Defined in Distribution.Types.BuildInfo Methods structure :: Proxy BuildInfo -> Structure Source # structureHash' :: Tagged BuildInfo MD5
Data BuildInfo Source #
Instance details Defined in Distribution.Types.BuildInfo Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BuildInfo -> c BuildInfo gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BuildInfo toConstr :: BuildInfo -> Constr dataTypeOf :: BuildInfo -> DataType dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BuildInfo) dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BuildInfo) gmapT :: (forall b. Data b => b -> b) -> BuildInfo -> BuildInfo gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BuildInfo -> r gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BuildInfo -> r gmapQ :: (forall d. Data d => d -> u) -> BuildInfo -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> BuildInfo -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> BuildInfo -> m BuildInfo gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BuildInfo -> m BuildInfo gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BuildInfo -> m BuildInfo
Monoid BuildInfo Source #
Instance details Defined in Distribution.Types.BuildInfo Methods mempty :: BuildInfo # mappend :: BuildInfo -> BuildInfo -> BuildInfo # mconcat :: [BuildInfo] -> BuildInfo #
Semigroup BuildInfo Source #
Instance details Defined in Distribution.Types.BuildInfo Methods (<>) :: BuildInfo -> BuildInfo -> BuildInfo # sconcat :: NonEmpty BuildInfo -> BuildInfo stimes :: Integral b => b -> BuildInfo -> BuildInfo
Generic BuildInfo Source #
Instance details Defined in Distribution.Types.BuildInfo Associated Types type Rep BuildInfo :: Type -> Type Methods from :: BuildInfo -> Rep BuildInfo x to :: Rep BuildInfo x -> BuildInfo
Read BuildInfo Source #
Instance details Defined in Distribution.Types.BuildInfo Methods readsPrec :: Int -> ReadS BuildInfo # readList :: ReadS [BuildInfo] # readPrec :: ReadPrec BuildInfo readListPrec :: ReadPrec [BuildInfo]
Show BuildInfo Source #
Instance details Defined in Distribution.Types.BuildInfo Methods showsPrec :: Int -> BuildInfo -> ShowS # show :: BuildInfo -> String # showList :: [BuildInfo] -> ShowS #
Binary BuildInfo Source #
Instance details Defined in Distribution.Types.BuildInfo Methods put :: BuildInfo -> Put # get :: Get BuildInfo # putList :: [BuildInfo] -> Put #
NFData BuildInfo Source #
Instance details Defined in Distribution.Types.BuildInfo Methods rnf :: BuildInfo -> () #
Eq BuildInfo Source #
Instance details Defined in Distribution.Types.BuildInfo Methods (==) :: BuildInfo -> BuildInfo -> Bool # (/=) :: BuildInfo -> BuildInfo -> Bool #
Ord BuildInfo Source #
Instance details Defined in Distribution.Types.BuildInfo Methods compare :: BuildInfo -> BuildInfo -> Ordering # (<) :: BuildInfo -> BuildInfo -> Bool # (<=) :: BuildInfo -> BuildInfo -> Bool # (>) :: BuildInfo -> BuildInfo -> Bool # (>=) :: BuildInfo -> BuildInfo -> Bool # max :: BuildInfo -> BuildInfo -> BuildInfo # min :: BuildInfo -> BuildInfo -> BuildInfo #
type Rep BuildInfo Source #
Instance details Defined in Distribution.Types.BuildInfo type Rep BuildInfo = D1 ('MetaData "BuildInfo" "Distribution.Types.BuildInfo" "Cabal-syntax-3.13.0.0-inplace" 'False) (C1 ('MetaCons "BuildInfo" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "buildable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :: S1 ('MetaSel ('Just "buildTools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [LegacyExeDependency])) :: (S1 ('MetaSel ('Just "buildToolDepends") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ExeDependency]) :: (S1 ('MetaSel ('Just "cppOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :: S1 ('MetaSel ('Just "asmOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String])))) :: ((S1 ('MetaSel ('Just "cmmOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :: (S1 ('MetaSel ('Just "ccOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :: S1 ('MetaSel ('Just "cxxOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]))) :: (S1 ('MetaSel ('Just "ldOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :: (S1 ('MetaSel ('Just "hsc2hsOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :: S1 ('MetaSel ('Just "pkgconfigDepends") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PkgconfigDependency]))))) :: (((S1 ('MetaSel ('Just "frameworks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [RelativePath Framework 'File]) :: (S1 ('MetaSel ('Just "extraFrameworkDirs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SymbolicPath Pkg ('Dir Framework)]) :: S1 ('MetaSel ('Just "asmSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SymbolicPath Pkg 'File]))) :: (S1 ('MetaSel ('Just "cmmSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SymbolicPath Pkg 'File]) :: (S1 ('MetaSel ('Just "cSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SymbolicPath Pkg 'File]) :: S1 ('MetaSel ('Just "cxxSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SymbolicPath Pkg 'File])))) :: ((S1 ('MetaSel ('Just "jsSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SymbolicPath Pkg 'File]) :: (S1 ('MetaSel ('Just "hsSourceDirs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SymbolicPath Pkg ('Dir Source)]) :: S1 ('MetaSel ('Just "otherModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ModuleName]))) :: (S1 ('MetaSel ('Just "virtualModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ModuleName]) :: (S1 ('MetaSel ('Just "autogenModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ModuleName]) :: S1 ('MetaSel ('Just "defaultLanguage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Language))))))) :: ((((S1 ('MetaSel ('Just "otherLanguages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Language]) :: S1 ('MetaSel ('Just "defaultExtensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Extension])) :: (S1 ('MetaSel ('Just "otherExtensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Extension]) :: (S1 ('MetaSel ('Just "oldExtensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Extension]) :: S1 ('MetaSel ('Just "extraLibs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String])))) :: ((S1 ('MetaSel ('Just "extraLibsStatic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :: (S1 ('MetaSel ('Just "extraGHCiLibs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :: S1 ('MetaSel ('Just "extraBundledLibs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]))) :: (S1 ('MetaSel ('Just "extraLibFlavours") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :: (S1 ('MetaSel ('Just "extraDynLibFlavours") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :: S1 ('MetaSel ('Just "extraLibDirs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SymbolicPath Pkg ('Dir Lib)]))))) :: (((S1 ('MetaSel ('Just "extraLibDirsStatic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SymbolicPath Pkg ('Dir Lib)]) :: (S1 ('MetaSel ('Just "includeDirs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SymbolicPath Pkg ('Dir Include)]) :: S1 ('MetaSel ('Just "includes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SymbolicPath Include 'File]))) :: (S1 ('MetaSel ('Just "autogenIncludes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [RelativePath Include 'File]) :: (S1 ('MetaSel ('Just "installIncludes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [RelativePath Include 'File]) :: S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PerCompilerFlavor [String]))))) :: ((S1 ('MetaSel ('Just "profOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PerCompilerFlavor [String])) :: (S1 ('MetaSel ('Just "sharedOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PerCompilerFlavor [String])) :: S1 ('MetaSel ('Just "staticOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PerCompilerFlavor [String])))) :: (S1 ('MetaSel ('Just "customFieldsBI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, String)]) :: (S1 ('MetaSel ('Just "targetBuildDepends") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Dependency]) :*: S1 ('MetaSel ('Just "mixins") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Mixin]))))))))

emptyBuildInfo :: BuildInfo Source #

allLanguages :: BuildInfo -> [Language] Source #

The Languages used by this component

allExtensions :: BuildInfo -> [Extension] Source #

The Extensions that are used somewhere by this component

usedExtensions :: BuildInfo -> [Extension] Source #

The Extensions that are used by all modules in this component

usesTemplateHaskellOrQQ :: BuildInfo -> Bool Source #

Whether any modules in this component use Template Haskell or Quasi Quotes

hcOptions :: CompilerFlavor -> BuildInfo -> [String] Source #

Select options for a particular Haskell compiler.

hcProfOptions :: CompilerFlavor -> BuildInfo -> [String] Source #

hcSharedOptions :: CompilerFlavor -> BuildInfo -> [String] Source #

hcStaticOptions :: CompilerFlavor -> BuildInfo -> [String] Source #